package com.syf.config.swagger;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @Data : 注解在类上, 为类提供读写get()/set()属性, 此外还提供了 equals()、hashCode()、toString() 方法
 * @Slf4j : 注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象
 * @Log4j : 注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象
 *
 * @ConfigurationProperties:为每个要捕获的外部属性(.yaml配置文件) 提供一个带有字段的类
 * 前缀定义了哪些外部属性将绑定到类的字段上,类的属性名称必须与外部属性的名称匹配
 */
@Data
//通过@EnableConfigurationProperties定义为Bean，配置文件中的前缀名为swagger2【获取配置文件中的信息】
@ConfigurationProperties(prefix = "swagger2")
public class SwaggerProperties {

    //包扫描的路径【获取配置文件中定义的swwager2扫描包路径   swagger2:base-package: com.syf.controller 】
    private  String basePackage ;

    //联系人的名称（swagger2:name:）
    private String name ;

    //联系人的主页（swagger2:url:）
    private String url ;

    //联系人的邮箱（swagger2:email:）
    private String email ;

    //API的标题
    private String  title  ;

    //API的描述
    private String description ;

    //API的版本号
    private String version ;

    //API的服务团队
    private String termsOfServiceUrl ;
}
